<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: shm/shm.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_ddb0f12d0722949f40b2818843b69123.html">shm</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">shm.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="shm_2shm_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Shared Memory</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment">// (See shm_fwd.hpp for doc header for this namespace.)</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1shm.html">ipc::shm</a></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>{</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"></span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment">/**</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"> * Implementation of #Arena_to_borrower_allocator_arena_t.  See specializations which actually contain the mapping for</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> * specific `Arena` types; for example: `Arena_to_shm_session&lt;classic::Pool_arena&gt;`,</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> * `Arena_to_shm_session&lt;arena_lend::jemalloc::Ipc_arena&gt;`.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> */</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Arena&gt;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structipc_1_1shm_1_1Arena__to__borrower__allocator__arena.html">   33</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structipc_1_1shm_1_1Arena__to__borrower__allocator__arena.html">Arena_to_borrower_allocator_arena</a></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>{<span class="comment"></span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment">  /// Implementation of #Arena_to_borrower_allocator_arena_t.  There is no default mapping; see specializations.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="structipc_1_1shm_1_1Arena__to__borrower__allocator__arena.html#a07db04e58910f1ed18349b4006e6be1b">   36</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="structipc_1_1shm_1_1Arena__to__borrower__allocator__arena.html#a07db04e58910f1ed18349b4006e6be1b">Type</a> = void;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>};</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"></span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment">/**</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * Alias that, given an `Arena` type (with `Arena::construct&lt;T&gt;()` which allocates/constructs a `T`), yields a</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * `Borrower_allocator_arena` type which can be used as the `Arena` arg to stl::Stateless_allocator for the</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * borrower-side counterpart `T`, usable in `Shm_session::borrow_object&lt;T&gt;()` to recover so-constructed</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * objects.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> *</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> * Informally, for informational convenience:</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> *   - Arena-sharing SHM-providers (classic::Pool_arena as of this writing), by definition, are symmetric, where</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> *     each side can both lend and borrow, allocate and write within the same `Arena`.  Hence they will</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> *     map `Arena` to itself.</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> *   - Arena-lending SHM-providers (arena_lend::jemalloc as of this writing), by definition, are asymmetric;</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *     the borrowing side can only read, not allocate.  Hence they will map `Arena` to a different borrower-arena</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> *     type only whose `Pointer` *type* member shall be used.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> *</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * @tparam Arena</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> *         SHM arena type that has method of the form `shared_ptr&lt;T&gt; construct&lt;T&gt;(...)`.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> */</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Arena&gt;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="namespaceipc_1_1shm.html#a6c8474d5b7dda220ed1f6693fc2e3c89">   57</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceipc_1_1shm.html#a6c8474d5b7dda220ed1f6693fc2e3c89">Arena_to_borrower_allocator_arena_t</a> = <span class="keyword">typename</span> <a class="code hl_typedef" href="structipc_1_1shm_1_1Arena__to__borrower__allocator__arena.html#a07db04e58910f1ed18349b4006e6be1b">Arena_to_borrower_allocator_arena&lt;Arena&gt;::Type</a>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>} <span class="comment">// namespace ipc::shm</span></div>
<div class="ttc" id="anamespaceipc_1_1shm_html"><div class="ttname"><a href="namespaceipc_1_1shm.html">ipc::shm</a></div><div class="ttdoc">Modules for SHared Memory (SHM) support.</div><div class="ttdef"><b>Definition:</b> <a href="shm_2classic_2classic_8hpp_source.html#l00025">classic.hpp:26</a></div></div>
<div class="ttc" id="anamespaceipc_1_1shm_html_a6c8474d5b7dda220ed1f6693fc2e3c89"><div class="ttname"><a href="namespaceipc_1_1shm.html#a6c8474d5b7dda220ed1f6693fc2e3c89">ipc::shm::Arena_to_borrower_allocator_arena_t</a></div><div class="ttdeci">typename Arena_to_borrower_allocator_arena&lt; Arena &gt;::Type Arena_to_borrower_allocator_arena_t</div><div class="ttdoc">Alias that, given an Arena type (with Arena::construct&lt;T&gt;() which allocates/constructs a T),...</div><div class="ttdef"><b>Definition:</b> <a href="shm_2shm_8hpp_source.html#l00057">shm.hpp:57</a></div></div>
<div class="ttc" id="astructipc_1_1shm_1_1Arena__to__borrower__allocator__arena_html"><div class="ttname"><a href="structipc_1_1shm_1_1Arena__to__borrower__allocator__arena.html">ipc::shm::Arena_to_borrower_allocator_arena</a></div><div class="ttdoc">Implementation of Arena_to_borrower_allocator_arena_t.</div><div class="ttdef"><b>Definition:</b> <a href="shm_2shm_8hpp_source.html#l00033">shm.hpp:34</a></div></div>
<div class="ttc" id="astructipc_1_1shm_1_1Arena__to__borrower__allocator__arena_html_a07db04e58910f1ed18349b4006e6be1b"><div class="ttname"><a href="structipc_1_1shm_1_1Arena__to__borrower__allocator__arena.html#a07db04e58910f1ed18349b4006e6be1b">ipc::shm::Arena_to_borrower_allocator_arena::Type</a></div><div class="ttdeci">void Type</div><div class="ttdoc">Implementation of Arena_to_borrower_allocator_arena_t. There is no default mapping; see specializatio...</div><div class="ttdef"><b>Definition:</b> <a href="shm_2shm_8hpp_source.html#l00036">shm.hpp:36</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
